Skip to content

[codex] Add lychee docs link checks and stable source links#2159

Draft
kkraus14 wants to merge 16 commits into
mainfrom
codex/docs-stable-source-linkcheck
Draft

[codex] Add lychee docs link checks and stable source links#2159
kkraus14 wants to merge 16 commits into
mainfrom
codex/docs-stable-source-linkcheck

Conversation

@kkraus14
Copy link
Copy Markdown
Collaborator

@kkraus14 kkraus14 commented Jun 1, 2026 •
edited
Loading

What changed

  • Add lychee-based docs link checking for changed/new .rst and .md links through pre-commit.
  • Add a rendered-docs lychee CI workflow that runs after the docs build/deploy job.
  • Have the docs build workflow publish the rendered HTML tree as an artifact for the downstream lychee workflow.
  • Run rendered-docs lychee checks against the local generated HTML artifact instead of the deployed PR preview.
  • Make docs example source links stable by using CUDA_PYTHON_DOCS_GITHUB_REF for release, preview, and latest builds.
  • Apply stable source-link handling to cuda.bindings, cuda.core, cuda.pathfinder, and cuda-python docs.
  • Clean up known broken docs links so lychee has a passing baseline.

Split

This PR is now only the docs link-checking and stable source-link work. Generated cuda.bindings pyobj-reference artifacts were split into #2167.

The earlier Sphinx linkcheck and check_example_links.py experiments were removed; lychee is the link checker for both local changed-link checks and rendered HTML checks.

Validation

  • git diff --check origin/main...HEAD
  • pixi run pre-commit run actionlint --files .github/workflows/build-docs.yml .github/workflows/check-doc-links.yml .github/workflows/ci.yml
  • pixi run pre-commit run check-yaml --files .github/workflows/build-docs.yml .github/workflows/check-doc-links.yml .github/workflows/ci.yml
  • Pre-commit hooks ran during the original commits, including lychee.
  • Split verification: this PR only touches docs link checking/workflow/config/source docs files, not generated cuda.bindings Cython artifacts.

@copy-pr-bot
Copy link
Copy Markdown
Contributor

copy-pr-bot Bot commented Jun 1, 2026

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@github-actions github-actions Bot added CI/CD CI/CD infrastructure cuda.bindings Everything related to the cuda.bindings module cuda.core Everything related to the cuda.core module labels Jun 1, 2026
@kkraus14 kkraus14 added the documentation Improvements or additions to documentation label Jun 1, 2026 — with ChatGPT Codex Connector
@kkraus14 kkraus14 added this to the cuda.bindings next milestone Jun 1, 2026
@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 1, 2026

/ok to test

@github-actions github-actions Bot added the cuda.pathfinder Everything related to the cuda.pathfinder module label Jun 1, 2026
@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 1, 2026

/ok to test

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 1, 2026

Doc Preview CI

🚀 View preview at
https://nvidia.github.io/cuda-python/pr-preview/pr-2159/

https://nvidia.github.io/cuda-python/pr-preview/pr-2159/cuda-core/

https://nvidia.github.io/cuda-python/pr-preview/pr-2159/cuda-bindings/

https://nvidia.github.io/cuda-python/pr-preview/pr-2159/cuda-pathfinder/


Preview will be ready when the GitHub Pages deployment is complete.

@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 2, 2026

/ok to test

4 similar comments
@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 2, 2026

/ok to test

@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 2, 2026

/ok to test

@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 2, 2026

/ok to test

@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 2, 2026

/ok to test

kkraus14
kkraus14 commented Jun 2, 2026
View reviewed changes
Comment thread cuda_bindings/docs/source/conf.py Outdated
Comment thread cuda_bindings/docs/source/release/13.2.0-notes.rst Outdated
Comment thread cuda_bindings/docs/source/release/13.1.1-notes.rst Outdated
Comment thread cuda_bindings/docs/source/release/12.9.6-notes.rst Outdated
Comment thread .pre-commit-config.yaml
@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 2, 2026

/ok to test

5 similar comments
@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 2, 2026

/ok to test

@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 2, 2026

/ok to test

@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 2, 2026

/ok to test

@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 2, 2026

/ok to test

@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 2, 2026

/ok to test

@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 2, 2026

pre-commit.ci run

@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 2, 2026

/ok to test

5 similar comments
@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 3, 2026

/ok to test

@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 3, 2026

/ok to test

@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 3, 2026

/ok to test

@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 3, 2026

/ok to test

@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 3, 2026

/ok to test

kkraus14
kkraus14 commented Jun 4, 2026
View reviewed changes
Comment thread cuda_bindings/docs/source/module/runtime.rst Outdated
Comment thread cuda_bindings/docs/source/module/runtime.rst Outdated
@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 4, 2026

/ok to test

kkraus14
kkraus14 commented Jun 4, 2026
View reviewed changes
Comment thread cuda_bindings/docs/source/module/runtime.rst Outdated
Comment thread cuda_bindings/docs/source/module/runtime.rst Outdated
Comment thread cuda_bindings/docs/source/module/runtime.rst Outdated
Comment thread cuda_bindings/docs/source/module/runtime.rst Outdated
Comment thread cuda_bindings/docs/source/module/runtime.rst Outdated
Comment thread cuda_bindings/docs/source/module/runtime.rst
Comment thread cuda_bindings/docs/source/module/runtime.rst Outdated
Comment thread cuda_bindings/docs/source/module/runtime.rst Outdated
@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 4, 2026

/ok to test

@kkraus14 kkraus14 force-pushed the codex/docs-stable-source-linkcheck branch from 1c6a8e3 to 3fdfd8c Compare June 4, 2026 16:27
@copy-pr-bot
Copy link
Copy Markdown
Contributor

copy-pr-bot Bot commented Jun 4, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@kkraus14 kkraus14 mentioned this pull request Jun 4, 2026
Draft
@kkraus14 kkraus14 changed the title [codex] Check versioned docs example links [codex] Check rendered docs links with lychee Jun 4, 2026
@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 4, 2026

/ok to test

@copy-pr-bot
Copy link
Copy Markdown
Contributor

copy-pr-bot Bot commented Jun 4, 2026

/ok to test

@kkraus14, there was an error processing your request: E1

See the following link for more information: https://docs.gha-runners.nvidia.com/cpr/e/1/

@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 4, 2026

Split update: PR #2159 now contains only the lychee-based docs link checking plus stable docs source-link changes across cuda.bindings, cuda.core, cuda.pathfinder, and cuda-python.

The generated cuda.bindings pyobj-reference artifacts were moved to #2167. The previous Sphinx linkcheck and check_example_links.py work was removed, so lychee is the only link-checking implementation in this PR.

@kkraus14 kkraus14 changed the title [codex] Check rendered docs links with lychee [codex] Add lychee docs link checks and stable source links Jun 4, 2026
kkraus14
kkraus14 commented Jun 4, 2026
View reviewed changes
Comment thread .github/workflows/build-docs.yml
Comment thread .github/workflows/build-docs.yml Outdated
@kkraus14 kkraus14 force-pushed the codex/docs-stable-source-linkcheck branch from 23c692d to e8bca70 Compare June 4, 2026 17:15
@kkraus14
Copy link
Copy Markdown
Collaborator Author

kkraus14 commented Jun 4, 2026

/ok to test

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

CI/CD CI/CD infrastructure cuda.bindings Everything related to the cuda.bindings module cuda.core Everything related to the cuda.core module cuda.pathfinder Everything related to the cuda.pathfinder module documentation Improvements or additions to documentation

Projects

None yet

Milestone

cuda.bindings next

Development

Successfully merging this pull request may close these issues.

1 participant

@kkraus14